kanzi::PageTransitionCollection Class Reference

Transition collection is used to define transitions within a Page Host. More...

#include <kanzi/ui/node/page_transition_collection.hpp>

Inheritance diagram for kanzi::PageTransitionCollection:

Classes
class	Runtime
	Runtime class that is instantiated per page. Drives the internal state manager that is used to animate transitions. More...
class	Transition
	Describes transition from one page to another. More...
class	TransitionAnimation
	Entry in transition animation array. More...

Public Types
typedef shared_ptr< Runtime >	RuntimeSharedPtr
typedef vector< TransitionAnimationSharedPtr >	TransitionAnimationContainer
	Container class for transition animations. More...
typedef shared_ptr< TransitionAnimation >	TransitionAnimationSharedPtr
	Shared ptr declaration for transition animation. More...
typedef TransitionContainer::const_iterator	TransitionConstIterator
typedef vector< TransitionSharedPtr >	TransitionContainer
	Container & iterator types for transitions. More...
typedef shared_ptr< Transition >	TransitionSharedPtr
	Shared ptr declaration for transition definition. More...
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	addTransition (TransitionSharedPtr transition)
	Add transition to transition group, needs to be called before transition group is attached to node tree. More...
RuntimeSharedPtr	attach (Page *node)
	Attach transitions to Page component. More...
TransitionConstIterator	beginTransitions () const
	Returns iterator to start of the transition container. More...
TransitionConstIterator	endTransitions () const
	Returns iterator to end of the transition container. More...
TransitionSharedPtr	findTransition (string_view source, string_view target)
	Finds matching transition definition for given parameters, falls back to default. More...
void	removeTransition (TransitionSharedPtr transition)
	Remove transition from transition group, needs to be called before transition group is attached to node tree. More...
	~PageTransitionCollection () override
Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...
const string &	getName () const
	Gets the resource name. More...
const string &	getUrl () const
	Gets the resource URL. More...
bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...
void	reload ()
void	reloadFromFile (string_view filePath)
void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...
void	setUrl (string_view url)
	Sets the resource URL. More...
	~Resource () override
	Destructor. More...
Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	applyObjectStyles ()
	Apply all styles for an object node. More...
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...
	Object (Domain *domain)
void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...
	~Object () override
Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...
virtual	~MetaObject ()
Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers. More...
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...
PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...
PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...
PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...
	PropertyObject ()
void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...
void	removeKzbProperties ()
	Remove all KZB properties. More...
template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...
void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...
virtual	~PropertyObject ()

Static Public Member Functions
static PageTransitionCollectionSharedPtr	create (Domain *domain, string_view name="")
static void	detach (RuntimeSharedPtr transitionGroupRuntime)
	Detach transitions from Page component. More...
static PageTransitionCollectionSharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads page transition collection from KZB and returns it. More...
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
Properties
static PropertyType< int >	PageTransitionDurationProperty
	PageTransitionDuration property. More...
static PropertyType< string >	PageTransitionFromProperty
	PageTransitionFrom property. More...
static PropertyType< string >	PageTransitionToProperty
	PageTransitionTo property. More...
static PropertyType< PageTransitionCollection::Transition::Direction >	PageTransitionDirectionProperty
	PageTransitionDirection property. More...
static PropertyType< string >	PageTransitionAnimationPropertyTypeProperty
	PageTransitionAnimationPropertyType property. More...
static PropertyType< PageTransitionCollection::Transition::AnimationTarget >	PageTransitionAnimationAnimationTargetProperty
	PageTransitionAnimationAnimationTarget property. More...
static PropertyType< string >	PageTransitionAnimationStartValueProperty
	PageTransitionAnimationStartValue property. More...
static PropertyType< string >	PageTransitionAnimationEndValueProperty
	PageTransitionAnimationEndValue property. More...

Protected Member Functions
	PageTransitionCollection (Domain *domain, string_view name="")
Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const
virtual void	reloadFromFileOverride (string_view filePath)
virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
virtual void	reloadOverride ()
	Resource (Domain *domain, string_view name)
	Constructor. More...
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()
	MetaObject ()
Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them. More...
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
	Internally adds a property value source. More...
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
	Internally adds a property value source. More...
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...
virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...
void	onCopy (const PropertyObject &other)
void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
	Removes a property value source. More...
void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers. More...
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers. More...

Friends
class	Page
class	ResourceManager

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Transition collection is used to define transitions within a Page Host.

Member Typedef Documentation

typedef shared_ptr<TransitionAnimation> kanzi::PageTransitionCollection::TransitionAnimationSharedPtr

Shared ptr declaration for transition animation.

typedef vector<TransitionAnimationSharedPtr> kanzi::PageTransitionCollection::TransitionAnimationContainer

Container class for transition animations.

typedef shared_ptr<Transition> kanzi::PageTransitionCollection::TransitionSharedPtr

Shared ptr declaration for transition definition.

typedef vector<TransitionSharedPtr> kanzi::PageTransitionCollection::TransitionContainer

Container & iterator types for transitions.

typedef TransitionContainer::const_iterator kanzi::PageTransitionCollection::TransitionConstIterator

typedef shared_ptr<Runtime> kanzi::PageTransitionCollection::RuntimeSharedPtr

Constructor & Destructor Documentation

kanzi::PageTransitionCollection::~PageTransitionCollection ( )

override

kanzi::PageTransitionCollection::PageTransitionCollection ( Domain *  domain, string_view  name = ""  )

explicitprotected

Member Function Documentation

static PageTransitionCollectionSharedPtr kanzi::PageTransitionCollection::create ( Domain *  domain, string_view  name = ""  )

static

void kanzi::PageTransitionCollection::addTransition

(

TransitionSharedPtr

transition

)

Add transition to transition group, needs to be called before transition group is attached to node tree.

Parameters

transition

Transition to add.

void kanzi::PageTransitionCollection::removeTransition

(

TransitionSharedPtr

transition

)

Remove transition from transition group, needs to be called before transition group is attached to node tree.

Parameters

transition

Transition to remove.

TransitionConstIterator kanzi::PageTransitionCollection::beginTransitions

(

)

const

Returns iterator to start of the transition container.

Returns

Iterator at the beginning of the container.

TransitionConstIterator kanzi::PageTransitionCollection::endTransitions

(

)

const

Returns iterator to end of the transition container.

Returns

Iterator at the end of the container.

TransitionSharedPtr kanzi::PageTransitionCollection::findTransition	(	string_view	source,
		string_view	target
	)

Finds matching transition definition for given parameters, falls back to default.

Parameters

source	Transition source, relative path to page host.
target	Transition target, relative path to page host.

Returns

The transition definition which has best match for this scenario.

RuntimeSharedPtr kanzi::PageTransitionCollection::attach

(

Page *

node

)

Attach transitions to Page component.

Parameters

node	Page node to which to attach transitions.

Returns

Runtime object that manages page transitions.

static void kanzi::PageTransitionCollection::detach ( RuntimeSharedPtr  transitionGroupRuntime )

static

Detach transitions from Page component.

Parameters

transitionGroupRuntime

Transitions to detach.

static PageTransitionCollectionSharedPtr kanzi::PageTransitionCollection::loadFromKZB ( Domain *  domain, string_view  name, KzbFile &  kzbFile, ReadOnlyMemoryFile &  file, KzbMemoryParser &  parser  )

static

Loads page transition collection from KZB and returns it.

Parameters

domain	Domain.
name	Name of page transition collection.
kzbFile	KZB to read page transition collection from.
file	File entry in KZB which contains page transition collection data.
parser	Parser to parse page transition collection data.

Returns

Loaded page transition collection.

Friends And Related Function Documentation

friend class ResourceManager

friend

friend class Page

friend

Member Data Documentation

PropertyType<int> kanzi::PageTransitionCollection::PageTransitionDurationProperty

static

PageTransitionDuration property.

The duration of a Page node transition (in milliseconds). The default value is 500.

See also

setPageTransitionDuration(), getPageTransitionDuration()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionFromProperty

static

PageTransitionFrom property.

The selection criteria for the source Page node. Use * for any Page node. The default value is "".

See also

setPageTransitionFrom(), getPageTransitionFrom()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionToProperty

static

PageTransitionTo property.

The selection criteria for the target Page node. Use * for any Page node. The default value is "".

See also

setPageTransitionTo(), getPageTransitionTo()

PropertyType<PageTransitionCollection::Transition::Direction> kanzi::PageTransitionCollection::PageTransitionDirectionProperty

static

PageTransitionDirection property.

Defines whether the transition is unidirectional (one way) or bidirectional (two way). The default value is PageTransitionCollection::Transition::Bidirectional.

See also

setPageTransitionDirection(), getPageTransitionDirection()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionAnimationPropertyTypeProperty

static

PageTransitionAnimationPropertyType property.

Defines which property to animate. The default value is "".

See also

setPageTransitionAnimationPropertyType(), getPageTransitionAnimationPropertyType()

PropertyType<PageTransitionCollection::Transition::AnimationTarget> kanzi::PageTransitionCollection::PageTransitionAnimationAnimationTargetProperty

static

PageTransitionAnimationAnimationTarget property.

Defines the animation target, either page transitioning in or page transitioning out. The default value is PageTransitionCollection::Transition::PageIn.

See also

setPageTransitionAnimationAnimationTarget(), getPageTransitionAnimationAnimationTarget()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionAnimationStartValueProperty

static

PageTransitionAnimationStartValue property.

The starting value for the animation. The default value is "".

See also

setPageTransitionAnimationStartValue(), getPageTransitionAnimationStartValue()

PropertyType<string> kanzi::PageTransitionCollection::PageTransitionAnimationEndValueProperty

static

PageTransitionAnimationEndValue property.

The ending value for the animation. The default value is "".

See also

setPageTransitionAnimationEndValue(), getPageTransitionAnimationEndValue()

---

The documentation for this class was generated from the following file:

• kanzi/ui/node/page_transition_collection.hpp